<!doctype html>
<html lang="en-US">
<head>
	<meta charset="UTF-8" />
	<title>Congo Documentation</title>
	<link rel="stylesheet" type="text/css" href="pagestyle.css" />
</head>
<body>
	<div class="sheet container">
		<header class="main">

			<div class="title">
				<a href="Modules_congo.html"><img src="data/congo.png"/></a>Congo Documentation
			</div>

		</header>

		<div class="row content">
			<div class="span12">
			
				
<h1>Class <span class="name">Action</span></h1>


	<p>Abstract base class for all actions
	</p>


<hr>

<table class="table scope-contents">
	
	
	
	
	
		<tr>
			<td class="span1 name">Extended&nbsp;by:</td>
			<td>
				<ul class="unstyled">
					<li><a href="Modules_congo.action_ActionCombined.html">ActionCombined</a>, <a href="Modules_congo.action_ActionDelay.html">ActionDelay</a>, <a href="Modules_congo.action_ActionFadeTo.html">ActionFadeTo</a>, <a href="Modules_congo.action_ActionMoveBy.html">ActionMoveBy</a>, <a href="Modules_congo.action_ActionMoveTo.html">ActionMoveTo</a>, <a href="Modules_congo.action_ActionRotateBy.html">ActionRotateBy</a>, <a href="Modules_congo.action_ActionRotateTo.html">ActionRotateTo</a>, <a href="Modules_congo.action_ActionScaleTo.html">ActionScaleTo</a>, <a href="Modules_congo.action_ActionSequence.html">ActionSequence</a></li>
				</ul>
			</td>
		</tr>
	

	

	
	
	
	
	

	

	
	
	
	
								
		<tr>
			<td class="span1 name">Properties:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='#IsComplete'>IsComplete</a> : Bool ()</li>
					
				</ul>
			</td>
		</tr>
	
	
								
		<tr>
			<td class="span1 name">Methods:</td>
			<td>
				<ul class="unstyled">
					
						<li><a href='Modules_congo.action_Action.html#Init'>Init</a> : Void ( item:DisplayItem, duration:Float, ease:EaseFunction, repeats:Int=1, actionId:Int=0 )</li>
					
						<li><a href='Modules_congo.action_Action.html#OnTimerComplete'>OnTimerComplete</a> : Void ()</li>
					
						<li><a href='Modules_congo.action_Action.html#ResetItemData'>ResetItemData</a> : Void ()</li>
					
						<li><a href='Modules_congo.action_Action.html#Update'>Update</a> : Void ( dT:Float )</li>
					
				</ul>
			</td>
		</tr>
	

	
	
	
	
	
	
	
	
</table>









						
	<h2>Property Documentation</h2>
	<div class="scope-members-list">
		
			<div class="item">
				<a name='IsComplete'></a>
				<div class="well well-small name"><b>Method IsComplete : Bool () Property</b></div>
				<div class="description">
					<p>	Returns True is action is complete. Will still return False if action has repeats to run.</p>
					
					
				</div>
			</div>
		
	</div>
	<hr>


						
	<h2>Method Documentation</h2>
	<div class="scope-members-list">
		
			<div class="item">
				<a name='Init'></a>
				<div class="well well-small name"><b>Method Init : Void ( item:<a href="Modules_congo.displayitem_DisplayItem.html">DisplayItem</a>, duration:Float, ease:<a href="Modules_congo.easefunction_EaseFunction.html">EaseFunction</a>, repeats:Int=1, actionId:Int=0 )</b></div>
				<div class="description">
					<p>	Initialises data common to all actions. Derived classes call this in their constr.</p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='OnTimerComplete'></a>
				<div class="well well-small name"><b>Method OnTimerComplete : Void ()</b></div>
				<div class="description">
					<p>	Internal. Gets called when actions complete each cycle. They are then repeated if more loops remain, 
	else the ActionCompleted callback is triggered.</p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='ResetItemData'></a>
				<div class="well well-small name"><b>Method ResetItemData : Void ()</b></div>
				<div class="description">
					<p>	Derived actions must implement this. Takes the current item/sprite data and stores it.
	e.g. ActionMoveTo will store the current item/sprite position.</p>
					
					
				</div>
			</div>
		
			<div class="item">
				<a name='Update'></a>
				<div class="well well-small name"><b>Method Update : Void ( dT:Float )</b></div>
				<div class="description">
					<p>	Derived actions must implement this.</p>
					
					
				</div>
			</div>
		
	</div>
	<hr>




				
			</div>
		</div>
	</div>
</body>
</html>